﻿// //  ********************************************************************************
// //  Copyright (C) 2016 Sebastian Kenter. All rights reserved.
// // 
// //  Name    : PhotonServerProject | PhotonServerFramework | IRealmConfiguration.cs
// //  Created : 2016 - 03 - 21 09:58
// //  Modified: 2016 - 04 - 18 09:38
// //  ********************************************************************************

namespace PhotonServerFramework.Interfaces.Configuration
{
    /// <summary>
    ///     Interface for the definition of a realm
    /// </summary>
    public interface IRealmConfiguration
    {
        /// <summary>
        ///     The unique id of the realm
        /// </summary>
        string RealmId { get; set; }

        /// <summary>
        ///     The name of the realm
        /// </summary>
        string RealmName { get; set; }

        /// <summary>
        ///     The server id of the realm serves this realm is hostet on
        /// </summary>
        string RealmServerId { get; set; }

        /// <summary>
        ///     The current population of the ream
        /// </summary>
        int CurrentPopulation { get; set; }

        /// <summary>
        ///     The maximum allowed population of the realm
        /// </summary>
        int MaximumPopulation { get; set; }

        /// <summary>
        ///     The wait queue of the realm
        /// </summary>
        int Queue { get; set; }

        /// <summary>
        ///     The region of the realm
        /// </summary>
        string Region { get; set; }
    }
}
